home *** CD-ROM | disk | FTP | other *** search
/ Inter.Net 55-1 / Inter.Net 55-1.iso / CBuilder / Setup / BCB / data.z / ws2atm.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-02-09  |  16.5 KB  |  454 lines

  1. /*
  2.  *      C/C++ Run Time Library - Version 9.0
  3.  *
  4.  *      Copyright (c) 1997, 1998 by Borland International
  5.  *      All Rights Reserved.
  6.  *
  7.  */
  8.  
  9. #ifndef _WS2ATM_H_
  10. #define _WS2ATM_H_
  11. #pragma option push -b
  12.  
  13. #pragma pack(1)
  14.  
  15.  
  16. #define ATMPROTO_AALUSER           0x00   /* User-defined AAL */
  17. #define ATMPROTO_AAL1              0x01   /* AAL 1 */
  18. #define ATMPROTO_AAL2              0x02   /* AAL 2 */
  19. #define ATMPROTO_AAL34             0x03   /* AAL 3/4 */
  20. #define ATMPROTO_AAL5              0x05   /* AAL 5 */
  21.  
  22. #define SAP_FIELD_ABSENT           0xFFFFFFFE
  23. #define SAP_FIELD_ANY              0xFFFFFFFF
  24. #define SAP_FIELD_ANY_AESA_SEL     0xFFFFFFFA
  25. #define SAP_FIELD_ANY_AESA_REST    0xFFFFFFFB
  26.  
  27. /* 
  28.  *  values used for AddressType in struct ATM_ADDRESS
  29.  */
  30. #define ATM_E164               0x01   /* E.164 addressing scheme */
  31. #define ATM_NSAP               0x02   /* NSAP-style ATM Endsystem Address scheme */
  32. #define ATM_AESA               0x02   /* NSAP-style ATM Endsystem Address scheme */
  33.  
  34. #define ATM_ADDR_SIZE          20     
  35. typedef struct {
  36.     DWORD AddressType;                /* E.164 or NSAP-style ATM Endsystem Address */
  37.     DWORD NumofDigits;                /* number of digits; */
  38.     UCHAR Addr[ATM_ADDR_SIZE];        /* IA5 digits for E164, BCD encoding for NSAP */
  39.                                       /* format as defined in the ATM Forum UNI 3.1 */
  40. } ATM_ADDRESS;
  41.  
  42. /* 
  43.  *  values used for Layer2Protocol in B-LLI
  44.  */
  45. #define BLLI_L2_ISO_1745           0x01   /* Basic mode ISO 1745                      */
  46. #define BLLI_L2_Q921               0x02   /* CCITT Rec. Q.921                         */
  47. #define BLLI_L2_X25L               0x06   /* CCITT Rec. X.25, link layer              */
  48. #define BLLI_L2_X25M               0x07   /* CCITT Rec. X.25, multilink               */
  49. #define BLLI_L2_ELAPB              0x08   /* Extended LAPB; for half duplex operation */
  50. #define BLLI_L2_HDLC_NRM           0x09   /* HDLC NRM (ISO 4335)                      */
  51. #define BLLI_L2_HDLC_ABM           0x0A   /* HDLC ABM (ISO 4335)                      */
  52. #define BLLI_L2_HDLC_ARM           0x0B   /* HDLC ARM (ISO 4335)                      */
  53. #define BLLI_L2_LLC                0x0C   /* LAN logical link control (ISO 8802/2)    */
  54. #define BLLI_L2_X75                0x0D   /* CCITT Rec. X.75, single link procedure   */
  55. #define BLLI_L2_Q922               0x0E   /* CCITT Rec. Q.922                         */
  56. #define BLLI_L2_USER_SPECIFIED     0x10   /* User Specified                           */
  57. #define BLLI_L2_ISO_7776           0x11   /* ISO 7776 DTE-DTE operation               */
  58.  
  59. /* 
  60.  *  values used for Layer3Protocol in B-LLI
  61.  */
  62. #define BLLI_L3_X25                0x06   /* CCITT Rec. X.25, packet layer            */
  63. #define BLLI_L3_ISO_8208           0x07   /* ISO/IEC 8208 (X.25 packet layer for DTE  */
  64. #define BLLI_L3_X223               0x08   /* X.223/ISO 8878                           */
  65. #define BLLI_L3_SIO_8473           0x09   /* ISO/IEC 8473 (OSI connectionless)        */
  66. #define BLLI_L3_T70                0x0A   /* CCITT Rec. T.70 min. network layer       */
  67. #define BLLI_L3_ISO_TR9577         0x0B   /* ISO/IEC TR 9577 Network Layer Protocol ID*/
  68. #define BLLI_L3_USER_SPECIFIED     0x10   /* User Specified                           */
  69.  
  70. /* 
  71.  *  values used for Layer3IPI in B-LLI
  72.  */
  73. #define BLLI_L3_IPI_SNAP           0x80   /* IEEE 802.1 SNAP identifier               */
  74. #define BLLI_L3_IPI_IP             0xCC   /* Internet Protocol (IP) identifier        */
  75.  
  76. typedef struct {
  77.     DWORD Layer2Protocol;                 /* User information layer 2 protocol           */
  78.     DWORD Layer2UserSpecifiedProtocol;    /* User specified layer 2 protocol information */
  79.     DWORD Layer3Protocol;                 /* User information layer 3 protocol           */
  80.     DWORD Layer3UserSpecifiedProtocol;    /* User specified layer 3 protocol information */
  81.     DWORD Layer3IPI;                      /* ISO/IEC TR 9577 Initial Protocol Identifier */
  82.     UCHAR SnapID[5];                      /* SNAP ID consisting of OUI and PID           */
  83. } ATM_BLLI;
  84.  
  85. /* 
  86.  *  values used for the HighLayerInfoType field in ATM_BHLI
  87.  */
  88. #define BHLI_ISO                   0x00   /* ISO                                 */
  89. #define BHLI_UserSpecific          0x01   /* User Specific                       */
  90. #define BHLI_HighLayerProfile      0x02   /* High layer profile (only in UNI3.0) */
  91. #define BHLI_VendorSpecificAppId   0x03   /* Vendor-Specific Application ID      */
  92.  
  93. typedef struct {
  94.     DWORD HighLayerInfoType;          /* High Layer Information Type      */
  95.     DWORD HighLayerInfoLength;        /* number of bytes in HighLayerInfo */
  96.     UCHAR HighLayerInfo[8];           /* the value dependent on the       */
  97.                                       /*   HighLayerInfoType field        */
  98. } ATM_BHLI;
  99.  
  100. struct sockaddr_atm {
  101.     u_short satm_family;              /* address family should be AF_ATM  */
  102.     ATM_ADDRESS satm_number;          /* ATM address                      */
  103.     ATM_BLLI satm_blli;               /* B-LLI                            */
  104.     ATM_BHLI satm_bhli;               /* B-HLI                            */
  105. };
  106.  
  107. typedef enum {
  108.     IE_AALParameters,
  109.     IE_TrafficDescriptor,
  110.     IE_BroadbandBearerCapability,
  111.     IE_BHLI,
  112.     IE_BLLI,
  113.     IE_CalledPartyNumber,
  114.     IE_CalledPartySubaddress,
  115.     IE_CallingPartyNumber,
  116.     IE_CallingPartySubaddress,
  117.     IE_Cause,
  118.     IE_QOSClass,
  119.     IE_TransitNetworkSelection,
  120. } Q2931_IE_TYPE;
  121.  
  122. typedef struct {
  123.     Q2931_IE_TYPE IEType;
  124.     ULONG         IELength;
  125.     UCHAR         IE[1];
  126. } Q2931_IE;
  127.  
  128. /* 
  129.  *  manifest constants for the AALType field in struct AAL_PARAMETERS_IE
  130.  */
  131. typedef enum {
  132.     AALTYPE_5     = 5,   /* AAL 5 */
  133.     AALTYPE_USER  = 16,  /* user-defined AAL */
  134. } AAL_TYPE;
  135.  
  136. /* 
  137.  *  values used for the Mode field in struct AAL5_PARAMETERS
  138.  */
  139. #define AAL5_MODE_MESSAGE           0x01
  140. #define AAL5_MODE_STREAMING         0x02
  141.  
  142. /* 
  143.  *  values used for the SSCSType field in struct AAL5_PARAMETERS
  144.  */
  145. #define AAL5_SSCS_NULL              0x00
  146. #define AAL5_SSCS_SSCOP_ASSURED     0x01
  147. #define AAL5_SSCS_SSCOP_NON_ASSURED 0x02
  148. #define AAL5_SSCS_FRAME_RELAY       0x04
  149.  
  150. typedef struct {
  151.     ULONG ForwardMaxCPCSSDUSize;
  152.     ULONG BackwardMaxCPCSSDUSize;
  153.     UCHAR Mode;                        /* only available in UNI 3.0 */
  154.     UCHAR SSCSType;
  155. } AAL5_PARAMETERS;
  156.  
  157. typedef struct {
  158.     ULONG UserDefined;
  159. } AALUSER_PARAMETERS; 
  160.     
  161. typedef struct {
  162.     AAL_TYPE AALType;
  163.     union {
  164.         AAL5_PARAMETERS     AAL5Parameters;
  165.         AALUSER_PARAMETERS  AALUserParameters;
  166.     } AALSpecificParameters;
  167. } AAL_PARAMETERS_IE;
  168.  
  169. typedef struct {
  170.     ULONG PeakCellRate_CLP0;
  171.     ULONG PeakCellRate_CLP01;
  172.     ULONG SustainableCellRate_CLP0;
  173.     ULONG SustainableCellRate_CLP01;
  174.     ULONG MaxBurstSize_CLP0;
  175.     ULONG MaxBurstSize_CLP01;
  176.     BOOL  Tagging;
  177. } ATM_TD;
  178.  
  179. typedef struct {
  180.     ATM_TD Forward;
  181.     ATM_TD Backward;
  182.     BOOL   BestEffort;
  183. } ATM_TRAFFIC_DESCRIPTOR_IE;
  184.  
  185. /* 
  186.  *  values used for the BearerClass field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  187.  */
  188. #define BCOB_A                   0x01   /* Bearer class A                      */
  189. #define BCOB_C                   0x03   /* Bearer class C                      */
  190. #define BCOB_X                   0x10   /* Bearer class X                      */
  191.  
  192. /* 
  193.  *  values used for the TrafficType field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  194.  */
  195. #define TT_NOIND                 0x00   /* No indication of traffic type       */
  196. #define TT_CBR                   0x04   /* Constant bit rate                   */
  197. #define TT_VBR                   0x06   /* Variable bit rate                   */
  198.  
  199. /* 
  200.  *  values used for the TimingRequirements field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  201.  */
  202. #define TR_NOIND                 0x00   /* No timing requirement indication    */
  203. #define TR_END_TO_END            0x01   /* End-to-end timing required          */
  204. #define TR_NO_END_TO_END         0x02   /* End-to-end timing not required      */
  205.  
  206. /* 
  207.  *  values used for the ClippingSusceptability field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  208.  */
  209. #define CLIP_NOT                 0x00   /* Not susceptible to clipping         */
  210. #define CLIP_SUS                 0x20   /* Susceptible to clipping             */
  211.  
  212. /* 
  213.  *  values used for the UserPlaneConnectionConfig field in 
  214.  *  struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  215.  */
  216. #define UP_P2P                   0x00   /* Point-to-point connection           */
  217. #define UP_P2MP                  0x01   /* Point-to-multipoint connection      */
  218.  
  219. typedef struct {
  220.     UCHAR BearerClass;
  221.     UCHAR TrafficType;
  222.     UCHAR TimingRequirements;
  223.     UCHAR ClippingSusceptability;
  224.     UCHAR UserPlaneConnectionConfig;
  225. } ATM_BROADBAND_BEARER_CAPABILITY_IE;
  226.  
  227. typedef ATM_BHLI ATM_BHLI_IE;
  228.  
  229. /* 
  230.  *  values used for the Layer2Mode field in struct ATM_BLLI_IE
  231.  */
  232. #define BLLI_L2_MODE_NORMAL         0x40
  233. #define BLLI_L2_MODE_EXT            0x80
  234.  
  235. /* 
  236.  *  values used for the Layer3Mode field in struct ATM_BLLI_IE
  237.  */
  238. #define BLLI_L3_MODE_NORMAL         0x40
  239. #define BLLI_L3_MODE_EXT            0x80
  240.  
  241. /* 
  242.  *  values used for the Layer3DefaultPacketSize field in struct ATM_BLLI_IE
  243.  */
  244. #define BLLI_L3_PACKET_16           0x04
  245. #define BLLI_L3_PACKET_32           0x05
  246. #define BLLI_L3_PACKET_64           0x06
  247. #define BLLI_L3_PACKET_128          0x07
  248. #define BLLI_L3_PACKET_256          0x08
  249. #define BLLI_L3_PACKET_512          0x09
  250. #define BLLI_L3_PACKET_1024         0x0A
  251. #define BLLI_L3_PACKET_2048         0x0B
  252. #define BLLI_L3_PACKET_4096         0x0C
  253.  
  254. typedef struct {
  255.     DWORD Layer2Protocol;                 /* User information layer 2 protocol           */
  256.     UCHAR Layer2Mode;
  257.     UCHAR Layer2WindowSize;
  258.     DWORD Layer2UserSpecifiedProtocol;    /* User specified layer 2 protocol information */
  259.     DWORD Layer3Protocol;                 /* User information layer 3 protocol           */
  260.     UCHAR Layer3Mode;
  261.     UCHAR Layer3DefaultPacketSize;
  262.     UCHAR Layer3PacketWindowSize;
  263.     DWORD Layer3UserSpecifiedProtocol;    /* User specified layer 3 protocol information */
  264.     DWORD Layer3IPI;                      /* ISO/IEC TR 9577 Initial Protocol Identifier */
  265.     UCHAR SnapID[5];                      /* SNAP ID consisting of OUI and PID           */
  266. } ATM_BLLI_IE;
  267.  
  268. typedef ATM_ADDRESS ATM_CALLED_PARTY_NUMBER_IE;
  269.  
  270. typedef ATM_ADDRESS ATM_CALLED_PARTY_SUBADDRESS_IE;
  271.  
  272. /* 
  273.  *  values used for the Presentation_Indication field in 
  274.  *  struct ATM_CALLING_PARTY_NUMBER_IE
  275.  */
  276. #define PI_ALLOWED                  0x00
  277. #define PI_RESTRICTED               0x40
  278. #define PI_NUMBER_NOT_AVAILABLE     0x80
  279.  
  280. /* 
  281.  *  values used for the Screening_Indicator field in 
  282.  *  struct ATM_CALLING_PARTY_NUMBER_IE
  283.  */
  284. #define SI_USER_NOT_SCREENED        0x00
  285. #define SI_USER_PASSED              0x01
  286. #define SI_USER_FAILED              0x02
  287. #define SI_NETWORK                  0x03
  288.  
  289. typedef struct {
  290.     ATM_ADDRESS ATM_Number;
  291.     UCHAR       Presentation_Indication;
  292.     UCHAR       Screening_Indicator;
  293. } ATM_CALLING_PARTY_NUMBER_IE;
  294.  
  295. typedef ATM_ADDRESS ATM_CALLING_PARTY_SUBADDRESS_IE;
  296.  
  297. /* 
  298.  *  values used for the Location field in struct ATM_CAUSE_IE
  299.  */
  300. #define CAUSE_LOC_USER                      0x00
  301. #define CAUSE_LOC_PRIVATE_LOCAL             0x01
  302. #define CAUSE_LOC_PUBLIC_LOCAL              0x02
  303. #define CAUSE_LOC_TRANSIT_NETWORK           0x03
  304. #define CAUSE_LOC_PUBLIC_REMOTE             0x04
  305. #define CAUSE_LOC_PRIVATE_REMOTE            0x05
  306. #define CAUSE_LOC_INTERNATIONAL_NETWORK     0x06
  307. #define CAUSE_LOC_BEYOND_INTERWORKING       0x0A
  308.  
  309. /* 
  310.  *  values used for the Cause field in struct ATM_CAUSE_IE
  311.  */
  312. #define CAUSE_UNALLOCATED_NUMBER                0x01
  313. #define CAUSE_NO_ROUTE_TO_TRANSIT_NETWORK       0x02
  314. #define CAUSE_NO_ROUTE_TO_DESTINATION           0x03
  315. #define CAUSE_VPI_VCI_UNACCEPTABLE              0x0A
  316. #define CAUSE_NORMAL_CALL_CLEARING              0x10
  317. #define CAUSE_USER_BUSY                         0x11
  318. #define CAUSE_NO_USER_RESPONDING                0x12
  319. #define CAUSE_CALL_REJECTED                     0x15
  320. #define CAUSE_NUMBER_CHANGED                    0x16
  321. #define CAUSE_USER_REJECTS_CLIR                 0x17
  322. #define CAUSE_DESTINATION_OUT_OF_ORDER          0x1B
  323. #define CAUSE_INVALID_NUMBER_FORMAT             0x1C
  324. #define CAUSE_STATUS_ENQUIRY_RESPONSE           0x1E
  325. #define CAUSE_NORMAL_UNSPECIFIED                0x1F
  326. #define CAUSE_VPI_VCI_UNAVAILABLE               0x23
  327. #define CAUSE_NETWORK_OUT_OF_ORDER              0x26
  328. #define CAUSE_TEMPORARY_FAILURE                 0x29
  329. #define CAUSE_ACCESS_INFORMAION_DISCARDED       0x2B
  330. #define CAUSE_NO_VPI_VCI_AVAILABLE              0x2D
  331. #define CAUSE_RESOURCE_UNAVAILABLE              0x2F
  332. #define CAUSE_QOS_UNAVAILABLE                   0x31
  333. #define CAUSE_USER_CELL_RATE_UNAVAILABLE        0x33
  334. #define CAUSE_BEARER_CAPABILITY_UNAUTHORIZED    0x39
  335. #define CAUSE_BEARER_CAPABILITY_UNAVAILABLE     0x3A
  336. #define CAUSE_OPTION_UNAVAILABLE                0x3F
  337. #define CAUSE_BEARER_CAPABILITY_UNIMPLEMENTED   0x41
  338. #define CAUSE_UNSUPPORTED_TRAFFIC_PARAMETERS    0x49
  339. #define CAUSE_INVALID_CALL_REFERENCE            0x51
  340. #define CAUSE_CHANNEL_NONEXISTENT               0x52
  341. #define CAUSE_INCOMPATIBLE_DESTINATION          0x58
  342. #define CAUSE_INVALID_ENDPOINT_REFERENCE        0x59
  343. #define CAUSE_INVALID_TRANSIT_NETWORK_SELECTION 0x5B
  344. #define CAUSE_TOO_MANY_PENDING_ADD_PARTY        0x5C
  345. #define CAUSE_AAL_PARAMETERS_UNSUPPORTED        0x5D
  346. #define CAUSE_MANDATORY_IE_MISSING              0x60
  347. #define CAUSE_UNIMPLEMENTED_MESSAGE_TYPE        0x61
  348. #define CAUSE_UNIMPLEMENTED_IE                  0x63
  349. #define CAUSE_INVALID_IE_CONTENTS               0x64
  350. #define CAUSE_INVALID_STATE_FOR_MESSAGE         0x65
  351. #define CAUSE_RECOVERY_ON_TIMEOUT               0x66
  352. #define CAUSE_INCORRECT_MESSAGE_LENGTH          0x68
  353. #define CAUSE_PROTOCOL_ERROR                    0x6F
  354.  
  355. /* 
  356.  *  values used for the Condition portion of the Diagnostics field
  357.  *  in struct ATM_CAUSE_IE, for certain Cause values
  358.  */
  359. #define CAUSE_COND_UNKNOWN                  0x00
  360. #define CAUSE_COND_PERMANENT                0x01
  361. #define CAUSE_COND_TRANSIENT                0x02
  362.  
  363. /* 
  364.  *  values used for the Rejection Reason portion of the Diagnostics field
  365.  *  in struct ATM_CAUSE_IE, for certain Cause values
  366.  */
  367. #define CAUSE_REASON_USER                   0x00
  368. #define CAUSE_REASON_IE_MISSING             0x04
  369. #define CAUSE_REASON_IE_INSUFFICIENT        0x08
  370.  
  371. /* 
  372.  *  values used for the P-U flag of the Diagnostics field
  373.  *  in struct ATM_CAUSE_IE, for certain Cause values
  374.  */
  375. #define CAUSE_PU_PROVIDER                   0x00
  376. #define CAUSE_PU_USER                       0x08
  377.  
  378. /* 
  379.  *  values used for the N-A flag of the Diagnostics field
  380.  *  in struct ATM_CAUSE_IE, for certain Cause values
  381.  */
  382. #define CAUSE_NA_NORMAL                     0x00
  383. #define CAUSE_NA_ABNORMAL                   0x04
  384.  
  385. typedef struct {
  386.     UCHAR Location;
  387.     UCHAR Cause;
  388.     UCHAR DiagnosticsLength;
  389.     UCHAR Diagnostics[4];
  390. } ATM_CAUSE_IE;
  391.  
  392. /* 
  393.  *  values used for the QOSClassForward and QOSClassBackward
  394.  *  field in struct ATM_QOS_CLASS_IE
  395.  */
  396. #define QOS_CLASS0                  0x00
  397. #define QOS_CLASS1                  0x01
  398. #define QOS_CLASS2                  0x02
  399. #define QOS_CLASS3                  0x03
  400. #define QOS_CLASS4                  0x04
  401.  
  402. typedef struct {
  403.     UCHAR QOSClassForward;
  404.     UCHAR QOSClassBackward;
  405. } ATM_QOS_CLASS_IE;
  406.  
  407. /* 
  408.  *  values used for the TypeOfNetworkId field in struct ATM_TRANSIT_NETWORK_SELECTION_IE
  409.  */
  410. #define TNS_TYPE_NATIONAL           0x40
  411.  
  412. /* 
  413.  *  values used for the NetworkIdPlan field in struct ATM_TRANSIT_NETWORK_SELECTION_IE
  414.  */
  415. #define TNS_PLAN_CARRIER_ID_CODE    0x01
  416.  
  417. typedef struct {
  418.     UCHAR TypeOfNetworkId;
  419.     UCHAR NetworkIdPlan;
  420.     UCHAR NetworkIdLength;
  421.     UCHAR NetworkId[1];
  422. } ATM_TRANSIT_NETWORK_SELECTION_IE;
  423.  
  424. /*
  425.  *  ATM specific Ioctl codes
  426.  */
  427. #define SIO_GET_NUMBER_OF_ATM_DEVICES   0x50160001
  428. #define SIO_GET_ATM_ADDRESS             0xd0160002
  429. #define SIO_ASSOCIATE_PVC               0x90160003
  430. #define SIO_GET_ATM_CONNECTION_ID       0x50160004
  431.  
  432. /* ATM Connection Identifier */
  433.  
  434. typedef struct {
  435.     DWORD  DeviceNumber;
  436.     DWORD  VPI;
  437.     DWORD  VCI;
  438. } ATM_CONNECTION_ID;
  439.  
  440. /*
  441.  * Input buffer format for SIO_ASSOCIATE_PVC
  442.  */
  443.  
  444. typedef struct {
  445.    ATM_CONNECTION_ID   PvcConnectionId;
  446.    QOS                 PvcQos;
  447. } ATM_PVC_PARAMS;
  448.  
  449. #pragma pack()
  450.  
  451.  
  452. #pragma option pop
  453. #endif   /* _WS2ATM_H_ */
  454.